home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / mach10.zip / HPREADER.CTL < prev    next >
Text File  |  1990-06-26  |  7KB  |  157 lines
  1. ;
  2. ;
  3. ;HPReader.CTL
  4. ;
  5. ;This file is used to provide various information to HPReader so it can
  6. ;adapt to your system. Lines with a ; as the first character are treated
  7. ;as comments. Any other lines are treated as HPReader configuration
  8. ;parameters.
  9. ;
  10. ;-FIDO    Designates your system as a FIDO/OPUS/etc mail system. Use this
  11. ;         if your system uses the .MSG format.
  12. ;
  13. ;-HP      Designates your system as a HP mail system. HP formats use my
  14. ;         own specialized message file format that is much more efficient
  15. ;         than the above FIDO format. Unfortunately, it is incompatible
  16. ;         with almost everything. I suggest you use the above FIDO instead
  17. ;         of this one (unless you are very sure of what you are doing)
  18. ;
  19. ;         NOTE: You may use either -FIDO or -HP, but not both
  20. ;
  21. -FIDO
  22. ;
  23. ;-NODE    The -NODE parameter tells the net/node address that you are located
  24. ;         at. It is a mandatory parameter. DO NOT specify the zone; It isn't
  25. ;         necessary.
  26. ;
  27. -NODE 300/9
  28. ;
  29. ;-SYSNAME The -SYSNAME parameter specifies your name. HPReader will
  30. ;         automatically load this use when it is activated. (You may then
  31. ;         log on as other users with the ALT-L command)
  32. ;
  33. ;-SYSNAME SCOTT BAKER
  34. ;
  35. ;-NETMAIL This specifies the directory of your netmail message area. (also
  36. ;         refered to as your network mail area). NETMAIL is always the first
  37. ;         area loaded into HPReader. It is alos forced as a FIDO format area
  38. ;         regardless of the HP/FIDO setting.
  39. ;
  40. -NETMAIL I:\BINKLEY\MESSAGES
  41. ;
  42. ;-EGAVGA   Setting this option will tell HPReader to load in the EGA/VGA
  43. ;          43 or 50 line screen modes. (Note: If your system is already
  44. ;          running in a 43/50 line mode, HPReader will automatically detect
  45. ;          it and adjust the screen size accordingly)
  46. ;
  47. -EGAVGA
  48. ;
  49. ;-BIOSVIDEO Selecting this option will turn off HPReader's direct writes.
  50. ;           Writing to the screen is much faster than the BIOS routines,
  51. ;           so running with BIOS is usually not desirable. If you are
  52. ;           running a multitasker, such as DesqView, you may wish to turn
  53. ;           BIOSVIDEO on to prevent HPReader from overwriting your screen
  54. ;           windows.
  55. ;
  56. ;-BIOSVIDEO
  57. ;
  58. ;-FUNCTION Function specifies a function key definition. With HPReader, you
  59. ;          may specify (normal,shift,ctrl,or alt) F1 - F10 as macro keys.
  60. ;          Macro keys may store any string of characters up to 254 characters
  61. ;          long. Upon pressing the specified key, HPReader will act upon
  62. ;          the keys specified in the macro.
  63. ;
  64. ;          The format for the macro definition is as follows:
  65. ;
  66. ;                   -FUNCTION <keynum> <string of characters>
  67. ;
  68. ;          The key numbers are as follows:
  69. ;
  70. ;                  1-10 = F1-F10        11-20 = Shift F1-F10
  71. ;                 21-30 = Ctrl F1-F10   31-40 = Alt F1-F10
  72. ;
  73. ;          The <string of characters> may be any string of up to 255
  74. ;          characters. It may be only one line long, but may contain any
  75. ;          control characters and/or keyboard scan codes. To specify a control
  76. ;          character, use a carat (^) sign followed by the character (i.e.
  77. ;          CTRL-M would be ^M, CTRL-A would be ^A). Scan codes may be used
  78. ;          by inserting "\0xnn" where "nn" is the hexidecimal scan code of the
  79. ;          key you wish to insert.
  80. ;
  81. ;          EXAMPLES:
  82. ;
  83. ;           -FUNCTION 1 Scott Baker^MSysop of the Not-Yet-Named BBS^M\0x1F
  84. ;                This would send out "Scott Baker" and "Sysop of the Not-
  85. ;                Yet-Named BBS" followed by carriage returns. Then it would
  86. ;                send out ALT-S (the \0x1F). I use it to write my name and
  87. ;                save a message from the message editor. It would be invoked
  88. ;                with F1.
  89. ;
  90. ;           -FUNCTION 11 \0x1E\0x50\0x50
  91. ;                This would send an ALT-A (the \0x1E) and two down arrow
  92. ;                keys (the \0x50's). From HPReader's main menu, it would
  93. ;                select <Change Area> (ALT-A) and move the pointer down two
  94. ;                lines. It would be invoked with SHIFT-F1.
  95. ;
  96. ;          NOTE: The function key definitions were intentionally made to
  97. ;                resemble the popular "MSGED" message editr by Jim Nutt
  98. ;                so users could easily convert thier macro definitions to/from
  99. ;                the two message editors.
  100. ;
  101. -FUNCTION 1 Scott Baker^MSysop of the Not-Yet-Named BBS^M\0x1F
  102. -FUNCTION 2 Scott Baker^MAuthor of HPReader^M\0x1F
  103. ;
  104. ;
  105. ;In addition to HPReader.CTL, HPReader will also search for an "AREAS.BBS"
  106. ;file an a "ECHOLIST.*" file. HPReader uses those files to load the following
  107. ;information:
  108. ;
  109. ;               AREAS.BBS: HPReader loads your listing of echos/bbs areas
  110. ;                          from this file. HPReader was intended to
  111. ;                          dynamically reconfigure itself based on what areas
  112. ;                          are available (i.e. If you change an area in your
  113. ;                          AREAS.BBS, HPReader will automatically use the
  114. ;                          updated information). This file is NOT optional.
  115. ;
  116. ;              ECHOLIST.*: The echolist files (which you should get from
  117. ;                          your net host) contain descriptions of all
  118. ;                          available areas. If found, HPReader will load area
  119. ;                          descriptions from this file. It is optional.
  120. ;
  121. ;            PRIVECHO.TXT: This is a special file that you may create
  122. ;                          yourself. It is intended to hold area descriptions
  123. ;                          for local areas and other areas that are not listed
  124. ;                          in your ECHOLIST.* file. It is a plain text file
  125. ;                          and contains lines of the following format:
  126. ;
  127. ;                              <Area TAG>  <Area DESCRIPTION>
  128. ;
  129. ;                          Example:
  130. ;
  131. ;                              MAIN        Our main message base.
  132. ;
  133. ;                          The spacing between parameters is not critical. You
  134. ;                          may also use PRIVECHO.TXT to override descriptions
  135. ;                          contained in the ECHOLIST.* file.
  136. ;
  137. ;The files are assumed to be in the current directory, but if you desire,
  138. ;you may tell HPReader to load from a different path with the following
  139. ;three commands:
  140. ;
  141. ;-AREASBBS <pathname>  Specifies path+filename of areas.bbs file
  142. ;-ECHOLIST <pathname>  Specifies path+filename of echolist.* file
  143. ;-PRIVECHO <pathname>  Specifies path+filename of Privecho.txt file
  144. ;
  145. -AREASBBS I:\Binkley\Areas.bbs
  146. -ECHOLIST I:\Binkley\Echolist.*
  147. -PRIVECHO I:\Binkley\Privecho.txt
  148. ;
  149. ;
  150. ;Well, that's it for parameters. One last note:
  151. ;
  152. ;NOTE: Any or all of these parameters may be located in your AREAS.BBS
  153. ;      file. (i.e. you can append this file to your AREAS.BBS and you will
  154. ;      have one less control file to worry about). If HPReader.CTL is missing,
  155. ;      HPReader will automatically parse the AREA.BBS file for these
  156. ;      parameters and assume defaults for anything not present.
  157.